<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="dialogflow_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3.projects.locations.agents.playbooks.html">playbooks</a> . <a href="dialogflow_v3.projects.locations.agents.playbooks.examples.html">examples</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an example in the specified playbook.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified example.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified example.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of examples in the specified playbook.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the specified example.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates an example in the specified playbook.

Args:
  parent: string, Required. The playbook to create an example for. Format: `projects//locations//agents//playbooks/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
  &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
    { # Action performed by end user or Dialogflow agent in the conversation.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a CX flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
      },
      &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
      },
      &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
  &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
    { # Action performed by end user or Dialogflow agent in the conversation.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a CX flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
      },
      &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
      },
      &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the specified example.

Args:
  name: string, Required. The name of the example to delete. Format: `projects//locations//agents//playbooks//examples/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves the specified example.

Args:
  name: string, Required. The name of the example. Format: `projects//locations//agents//playbooks//examples/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
  &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
    { # Action performed by end user or Dialogflow agent in the conversation.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a CX flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
      },
      &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
      },
      &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns a list of examples in the specified playbook.

Args:
  parent: string, Required. The playbook to list the examples from. Format: `projects//locations//agents//playbooks/`. (required)
  languageCode: string, Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.
  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
  pageToken: string, Optional. The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Examples.ListExamples.
  &quot;examples&quot;: [ # The list of examples. There will be a maximum number of items returned based on the page_size field in the request.
    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
      &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
        { # Action performed by end user or Dialogflow agent in the conversation.
          &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
          &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a CX flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
            &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
          },
          &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
          },
          &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
            &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
              &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
            },
            &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
              &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
            },
            &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
          },
          &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
          },
          &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
            &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
          },
          &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
        },
      ],
      &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
      &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
      &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
        &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
      },
      &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
        &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
      },
      &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Update the specified example.

Args:
  name: string, The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
  &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
    { # Action performed by end user or Dialogflow agent in the conversation.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a CX flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
      },
      &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
      },
      &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
}

  updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
  &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
    { # Action performed by end user or Dialogflow agent in the conversation.
      &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
      &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a CX flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.
        &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
      },
      &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
        &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
      },
      &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
          &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
        },
        &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
          &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        },
        &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
      },
      &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
        &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
      },
      &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
        &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
        &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
        &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
      },
      &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
        &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
      },
    },
  ],
  &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
  &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
  &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
    &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
  },
  &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
    &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
  },
  &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
}</pre>
</div>

</body></html>